2 use MediaWiki\MediaWikiServices
;
3 use MediaWiki\Storage\RevisionStore
;
4 use MediaWiki\Storage\IncompleteRevisionException
;
5 use MediaWiki\Storage\RevisionRecord
;
8 * RevisionDbTestBase contains test cases for the Revision class that have Database interactions.
13 abstract class RevisionDbTestBase
extends MediaWikiTestCase
{
16 * @var WikiPage $testPage
20 public function __construct( $name = null, array $data = [], $dataName = '' ) {
21 parent
::__construct( $name, $data, $dataName );
23 $this->tablesUsed
= array_merge( $this->tablesUsed
,
46 protected function setUp() {
51 $this->mergeMwGlobalArrayValue(
55 12313 => 'Dummy_talk',
59 $this->mergeMwGlobalArrayValue(
60 'wgNamespaceContentModels',
62 12312 => DummyContentForTesting
::MODEL_ID
,
66 $this->mergeMwGlobalArrayValue(
69 DummyContentForTesting
::MODEL_ID
=> 'DummyContentHandlerForTesting',
70 RevisionTestModifyableContent
::MODEL_ID
=> 'RevisionTestModifyableContentHandler',
74 $this->setMwGlobals( 'wgContentHandlerUseDB', $this->getContentHandlerUseDB() );
76 MWNamespace
::clearCaches();
77 // Reset namespace cache
78 $wgContLang->resetNamespaces();
80 if ( !$this->testPage
) {
82 * We have to create a new page for each subclass as the page creation may result
83 * in different DB fields being filled based on configuration.
85 $this->testPage
= $this->createPage( __CLASS__
, __CLASS__
);
89 protected function tearDown() {
94 MWNamespace
::clearCaches();
95 // Reset namespace cache
96 $wgContLang->resetNamespaces();
99 abstract protected function getContentHandlerUseDB();
101 private function makeRevisionWithProps( $props = null ) {
102 if ( $props === null ) {
106 if ( !isset( $props['content'] ) && !isset( $props['text'] ) ) {
107 $props['text'] = 'Lorem Ipsum';
110 if ( !isset( $props['user_text'] ) ) {
111 $props['user_text'] = 'Tester';
114 if ( !isset( $props['user'] ) ) {
118 if ( !isset( $props['comment'] ) ) {
119 $props['comment'] = 'just a test';
122 if ( !isset( $props['page'] ) ) {
123 $props['page'] = $this->testPage
->getId();
126 if ( !isset( $props['content_model'] ) ) {
127 $props['content_model'] = CONTENT_MODEL_WIKITEXT
;
130 $rev = new Revision( $props );
132 $dbw = wfGetDB( DB_MASTER
);
133 $rev->insertOn( $dbw );
139 * @param string $titleString
140 * @param string $text
141 * @param string|null $model
145 private function createPage( $titleString, $text, $model = null ) {
146 if ( !preg_match( '/:/', $titleString ) &&
147 ( $model === null ||
$model === CONTENT_MODEL_WIKITEXT
)
149 $ns = $this->getDefaultWikitextNS();
150 $titleString = MWNamespace
::getCanonicalName( $ns ) . ':' . $titleString;
153 $title = Title
::newFromText( $titleString );
154 $wikipage = new WikiPage( $title );
156 // Delete the article if it already exists
157 if ( $wikipage->exists() ) {
158 $wikipage->doDeleteArticle( "done" );
161 $content = ContentHandler
::makeContent( $text, $title, $model );
162 $wikipage->doEditContent( $content, __METHOD__
, EDIT_NEW
);
167 private function assertRevEquals( Revision
$orig, Revision
$rev = null ) {
168 $this->assertNotNull( $rev, 'missing revision' );
170 $this->assertEquals( $orig->getId(), $rev->getId() );
171 $this->assertEquals( $orig->getPage(), $rev->getPage() );
172 $this->assertEquals( $orig->getTimestamp(), $rev->getTimestamp() );
173 $this->assertEquals( $orig->getUser(), $rev->getUser() );
174 $this->assertEquals( $orig->getContentModel(), $rev->getContentModel() );
175 $this->assertEquals( $orig->getContentFormat(), $rev->getContentFormat() );
176 $this->assertEquals( $orig->getSha1(), $rev->getSha1() );
180 * @covers Revision::getRecentChange
182 public function testGetRecentChange() {
183 $rev = $this->testPage
->getRevision();
184 $recentChange = $rev->getRecentChange();
186 // Make sure various attributes look right / the correct entry has been retrieved.
187 $this->assertEquals( $rev->getTimestamp(), $recentChange->getAttribute( 'rc_timestamp' ) );
189 $rev->getTitle()->getNamespace(),
190 $recentChange->getAttribute( 'rc_namespace' )
193 $rev->getTitle()->getDBkey(),
194 $recentChange->getAttribute( 'rc_title' )
196 $this->assertEquals( $rev->getUser(), $recentChange->getAttribute( 'rc_user' ) );
197 $this->assertEquals( $rev->getUserText(), $recentChange->getAttribute( 'rc_user_text' ) );
198 $this->assertEquals( $rev->getComment(), $recentChange->getAttribute( 'rc_comment' ) );
199 $this->assertEquals( $rev->getPage(), $recentChange->getAttribute( 'rc_cur_id' ) );
200 $this->assertEquals( $rev->getId(), $recentChange->getAttribute( 'rc_this_oldid' ) );
204 * @covers Revision::insertOn
206 public function testInsertOn_success() {
207 $parentId = $this->testPage
->getLatest();
209 // If an ExternalStore is set don't use it.
210 $this->setMwGlobals( 'wgDefaultExternalStore', false );
212 $rev = new Revision( [
213 'page' => $this->testPage
->getId(),
214 'title' => $this->testPage
->getTitle(),
215 'text' => 'Revision Text',
216 'comment' => 'Revision comment',
219 $revId = $rev->insertOn( wfGetDB( DB_MASTER
) );
221 $this->assertInternalType( 'integer', $revId );
222 $this->assertSame( $revId, $rev->getId() );
224 // getTextId() must be an int!
225 $this->assertInternalType( 'integer', $rev->getTextId() );
227 $mainSlot = $rev->getRevisionRecord()->getSlot( 'main', RevisionRecord
::RAW
);
229 // we currently only support storage in the text table
230 $textId = MediaWikiServices
::getInstance()
232 ->getTextIdFromAddress( $mainSlot->getAddress() );
236 [ 'old_id', 'old_text' ],
238 [ [ strval( $textId ), 'Revision Text' ] ]
253 "rev_id = {$rev->getId()}",
255 strval( $rev->getId() ),
256 strval( $this->testPage
->getId() ),
263 's0ngbdoxagreuf2vjtuxzwdz64n29xm',
269 * @covers Revision::insertOn
271 public function testInsertOn_exceptionOnNoPage() {
272 // If an ExternalStore is set don't use it.
273 $this->setMwGlobals( 'wgDefaultExternalStore', false );
274 $this->setExpectedException(
275 IncompleteRevisionException
::class,
276 "rev_page field must not be 0!"
279 $title = Title
::newFromText( 'Nonexistant-' . __METHOD__
);
280 $rev = new Revision( [], 0, $title );
282 $rev->insertOn( wfGetDB( DB_MASTER
) );
286 * @covers Revision::newFromTitle
288 public function testNewFromTitle_withoutId() {
289 $latestRevId = $this->testPage
->getLatest();
291 $rev = Revision
::newFromTitle( $this->testPage
->getTitle() );
293 $this->assertTrue( $this->testPage
->getTitle()->equals( $rev->getTitle() ) );
294 $this->assertEquals( $latestRevId, $rev->getId() );
298 * @covers Revision::newFromTitle
300 public function testNewFromTitle_withId() {
301 $latestRevId = $this->testPage
->getLatest();
303 $rev = Revision
::newFromTitle( $this->testPage
->getTitle(), $latestRevId );
305 $this->assertTrue( $this->testPage
->getTitle()->equals( $rev->getTitle() ) );
306 $this->assertEquals( $latestRevId, $rev->getId() );
310 * @covers Revision::newFromTitle
312 public function testNewFromTitle_withBadId() {
313 $latestRevId = $this->testPage
->getLatest();
315 $rev = Revision
::newFromTitle( $this->testPage
->getTitle(), $latestRevId +
1 );
317 $this->assertNull( $rev );
321 * @covers Revision::newFromRow
323 public function testNewFromRow() {
324 $orig = $this->makeRevisionWithProps();
326 $dbr = wfGetDB( DB_REPLICA
);
327 $revQuery = Revision
::getQueryInfo();
328 $res = $dbr->select( $revQuery['tables'], $revQuery['fields'], [ 'rev_id' => $orig->getId() ],
329 __METHOD__
, [], $revQuery['joins'] );
330 $this->assertTrue( is_object( $res ), 'query failed' );
332 $row = $res->fetchObject();
335 $rev = Revision
::newFromRow( $row );
337 $this->assertRevEquals( $orig, $rev );
340 public function provideNewFromArchiveRow() {
348 return $f +
[ 'ar_namespace', 'ar_title' ];
353 unset( $f['ar_text'] );
359 unset( $f['ar_text_id'] );
365 unset( $f['ar_page_id'] );
371 unset( $f['ar_parent_id'] );
377 unset( $f['ar_rev_id'] );
383 unset( $f['ar_sha1'] );
390 * @dataProvider provideNewFromArchiveRow
391 * @covers Revision::newFromArchiveRow
393 public function testNewFromArchiveRow( $selectModifier ) {
394 $services = MediaWikiServices
::getInstance();
396 $store = new RevisionStore(
397 $services->getDBLoadBalancer(),
398 $services->getService( '_SqlBlobStore' ),
399 $services->getMainWANObjectCache()
402 $store->setContentHandlerUseDB( $this->getContentHandlerUseDB() );
403 $this->setService( 'RevisionStore', $store );
405 $page = $this->createPage(
406 'RevisionStorageTest_testNewFromArchiveRow',
408 CONTENT_MODEL_WIKITEXT
410 $orig = $page->getRevision();
411 $page->doDeleteArticle( 'test Revision::newFromArchiveRow' );
413 $dbr = wfGetDB( DB_REPLICA
);
414 $arQuery = Revision
::getArchiveQueryInfo();
415 $arQuery['fields'] = $selectModifier( $arQuery['fields'] );
417 $arQuery['tables'], $arQuery['fields'], [ 'ar_rev_id' => $orig->getId() ],
418 __METHOD__
, [], $arQuery['joins']
420 $this->assertTrue( is_object( $res ), 'query failed' );
422 $row = $res->fetchObject();
425 // MCR migration note: $row is now required to contain ar_title and ar_namespace.
426 // Alternatively, a Title object can be passed to RevisionStore::newRevisionFromArchiveRow
427 $rev = Revision
::newFromArchiveRow( $row );
429 $this->assertRevEquals( $orig, $rev );
433 * @covers Revision::newFromArchiveRow
435 public function testNewFromArchiveRowOverrides() {
436 $page = $this->createPage(
437 'RevisionStorageTest_testNewFromArchiveRow',
439 CONTENT_MODEL_WIKITEXT
441 $orig = $page->getRevision();
442 $page->doDeleteArticle( 'test Revision::newFromArchiveRow' );
444 $dbr = wfGetDB( DB_REPLICA
);
445 $arQuery = Revision
::getArchiveQueryInfo();
447 $arQuery['tables'], $arQuery['fields'], [ 'ar_rev_id' => $orig->getId() ],
448 __METHOD__
, [], $arQuery['joins']
450 $this->assertTrue( is_object( $res ), 'query failed' );
452 $row = $res->fetchObject();
455 $rev = Revision
::newFromArchiveRow( $row, [ 'comment_text' => 'SOMEOVERRIDE' ] );
457 $this->assertNotEquals( $orig->getComment(), $rev->getComment() );
458 $this->assertEquals( 'SOMEOVERRIDE', $rev->getComment() );
462 * @covers Revision::newFromId
464 public function testNewFromId() {
465 $orig = $this->testPage
->getRevision();
466 $rev = Revision
::newFromId( $orig->getId() );
467 $this->assertRevEquals( $orig, $rev );
471 * @covers Revision::newFromPageId
473 public function testNewFromPageId() {
474 $rev = Revision
::newFromPageId( $this->testPage
->getId() );
475 $this->assertRevEquals(
476 $this->testPage
->getRevision(),
482 * @covers Revision::newFromPageId
484 public function testNewFromPageIdWithLatestId() {
485 $rev = Revision
::newFromPageId(
486 $this->testPage
->getId(),
487 $this->testPage
->getLatest()
489 $this->assertRevEquals(
490 $this->testPage
->getRevision(),
496 * @covers Revision::newFromPageId
498 public function testNewFromPageIdWithNotLatestId() {
499 $content = new WikitextContent( __METHOD__
);
500 $this->testPage
->doEditContent( $content, __METHOD__
);
501 $rev = Revision
::newFromPageId(
502 $this->testPage
->getId(),
503 $this->testPage
->getRevision()->getPrevious()->getId()
505 $this->assertRevEquals(
506 $this->testPage
->getRevision()->getPrevious(),
512 * @covers Revision::fetchRevision
514 public function testFetchRevision() {
515 // Hidden process cache assertion below
516 $this->testPage
->getRevision()->getId();
518 $this->testPage
->doEditContent( new WikitextContent( __METHOD__
), __METHOD__
);
519 $id = $this->testPage
->getRevision()->getId();
521 $this->hideDeprecated( 'Revision::fetchRevision' );
522 $res = Revision
::fetchRevision( $this->testPage
->getTitle() );
524 # note: order is unspecified
526 while ( ( $row = $res->fetchObject() ) ) {
527 $rows[$row->rev_id
] = $row;
530 $this->assertEmpty( $rows, 'expected empty set' );
534 * @covers Revision::getPage
536 public function testGetPage() {
537 $page = $this->testPage
;
539 $orig = $this->makeRevisionWithProps( [ 'page' => $page->getId() ] );
540 $rev = Revision
::newFromId( $orig->getId() );
542 $this->assertEquals( $page->getId(), $rev->getPage() );
546 * @covers Revision::isCurrent
548 public function testIsCurrent() {
549 $rev1 = $this->testPage
->getRevision();
551 # @todo find out if this should be true
552 # $this->assertTrue( $rev1->isCurrent() );
554 $rev1x = Revision
::newFromId( $rev1->getId() );
555 $this->assertTrue( $rev1x->isCurrent() );
557 $this->testPage
->doEditContent( new WikitextContent( __METHOD__
), __METHOD__
);
558 $rev2 = $this->testPage
->getRevision();
560 # @todo find out if this should be true
561 # $this->assertTrue( $rev2->isCurrent() );
563 $rev1x = Revision
::newFromId( $rev1->getId() );
564 $this->assertFalse( $rev1x->isCurrent() );
566 $rev2x = Revision
::newFromId( $rev2->getId() );
567 $this->assertTrue( $rev2x->isCurrent() );
571 * @covers Revision::getPrevious
573 public function testGetPrevious() {
574 $oldestRevision = $this->testPage
->getOldestRevision();
575 $latestRevision = $this->testPage
->getLatest();
577 $this->assertNull( $oldestRevision->getPrevious() );
579 $this->testPage
->doEditContent( new WikitextContent( __METHOD__
), __METHOD__
);
580 $newRevision = $this->testPage
->getRevision();
582 $this->assertNotNull( $newRevision->getPrevious() );
583 $this->assertEquals( $latestRevision, $newRevision->getPrevious()->getId() );
587 * @covers Revision::getNext
589 public function testGetNext() {
590 $rev1 = $this->testPage
->getRevision();
592 $this->assertNull( $rev1->getNext() );
594 $this->testPage
->doEditContent( new WikitextContent( __METHOD__
), __METHOD__
);
595 $rev2 = $this->testPage
->getRevision();
597 $this->assertNotNull( $rev1->getNext() );
598 $this->assertEquals( $rev2->getId(), $rev1->getNext()->getId() );
602 * @covers Revision::newNullRevision
604 public function testNewNullRevision() {
605 $this->testPage
->doEditContent( new WikitextContent( __METHOD__
), __METHOD__
);
606 $orig = $this->testPage
->getRevision();
608 $dbw = wfGetDB( DB_MASTER
);
609 $rev = Revision
::newNullRevision( $dbw, $this->testPage
->getId(), 'a null revision', false );
611 $this->assertNotEquals( $orig->getId(), $rev->getId(),
612 'new null revision should have a different id from the original revision' );
613 $this->assertEquals( $orig->getTextId(), $rev->getTextId(),
614 'new null revision should have the same text id as the original revision' );
615 $this->assertEquals( $orig->getSha1(), $rev->getSha1(),
616 'new null revision should have the same SHA1 as the original revision' );
617 $this->assertTrue( $orig->getRevisionRecord()->hasSameContent( $rev->getRevisionRecord() ),
618 'new null revision should have the same content as the original revision' );
619 $this->assertEquals( __METHOD__
, $rev->getContent()->getNativeData() );
623 * @covers Revision::newNullRevision
625 public function testNewNullRevision_badPage() {
626 $dbw = wfGetDB( DB_MASTER
);
627 $rev = Revision
::newNullRevision( $dbw, -1, 'a null revision', false );
629 $this->assertNull( $rev );
633 * @covers Revision::insertOn
635 public function testInsertOn() {
636 $ip = '2600:387:ed7:947e:8c16:a1ad:dd34:1dd7';
638 $orig = $this->makeRevisionWithProps( [
642 // Make sure the revision was copied to ip_changes
643 $dbr = wfGetDB( DB_REPLICA
);
644 $res = $dbr->select( 'ip_changes', '*', [ 'ipc_rev_id' => $orig->getId() ] );
645 $row = $res->fetchObject();
647 $this->assertEquals( IP
::toHex( $ip ), $row->ipc_hex
);
649 $orig->getTimestamp(),
650 wfTimestamp( TS_MW
, $row->ipc_rev_timestamp
)
654 public static function provideUserWasLastToEdit() {
655 yield
'actually the last edit' => [ 3, true ];
656 yield
'not the current edit, but still by this user' => [ 2, true ];
657 yield
'edit by another user' => [ 1, false ];
658 yield
'first edit, by this user, but another user edited in the mean time' => [ 0, false ];
662 * @covers Revision::userWasLastToEdit
663 * @dataProvider provideUserWasLastToEdit
665 public function testUserWasLastToEdit( $sinceIdx, $expectedLast ) {
666 $userA = User
::newFromName( "RevisionStorageTest_userA" );
667 $userB = User
::newFromName( "RevisionStorageTest_userB" );
669 if ( $userA->getId() === 0 ) {
670 $userA = User
::createNew( $userA->getName() );
673 if ( $userB->getId() === 0 ) {
674 $userB = User
::createNew( $userB->getName() );
677 $ns = $this->getDefaultWikitextNS();
679 $dbw = wfGetDB( DB_MASTER
);
682 // create revisions -----------------------------
683 $page = WikiPage
::factory( Title
::newFromText(
684 'RevisionStorageTest_testUserWasLastToEdit', $ns ) );
685 $page->insertOn( $dbw );
687 $revisions[0] = new Revision( [
688 'page' => $page->getId(),
689 // we need the title to determine the page's default content model
690 'title' => $page->getTitle(),
691 'timestamp' => '20120101000000',
692 'user' => $userA->getId(),
694 'content_model' => CONTENT_MODEL_WIKITEXT
,
695 'comment' => 'edit zero'
697 $revisions[0]->insertOn( $dbw );
699 $revisions[1] = new Revision( [
700 'page' => $page->getId(),
701 // still need the title, because $page->getId() is 0 (there's no entry in the page table)
702 'title' => $page->getTitle(),
703 'timestamp' => '20120101000100',
704 'user' => $userA->getId(),
706 'content_model' => CONTENT_MODEL_WIKITEXT
,
707 'comment' => 'edit one'
709 $revisions[1]->insertOn( $dbw );
711 $revisions[2] = new Revision( [
712 'page' => $page->getId(),
713 'title' => $page->getTitle(),
714 'timestamp' => '20120101000200',
715 'user' => $userB->getId(),
717 'content_model' => CONTENT_MODEL_WIKITEXT
,
718 'comment' => 'edit two'
720 $revisions[2]->insertOn( $dbw );
722 $revisions[3] = new Revision( [
723 'page' => $page->getId(),
724 'title' => $page->getTitle(),
725 'timestamp' => '20120101000300',
726 'user' => $userA->getId(),
728 'content_model' => CONTENT_MODEL_WIKITEXT
,
729 'comment' => 'edit three'
731 $revisions[3]->insertOn( $dbw );
733 $revisions[4] = new Revision( [
734 'page' => $page->getId(),
735 'title' => $page->getTitle(),
736 'timestamp' => '20120101000200',
737 'user' => $userA->getId(),
739 'content_model' => CONTENT_MODEL_WIKITEXT
,
740 'comment' => 'edit four'
742 $revisions[4]->insertOn( $dbw );
744 // test it ---------------------------------
745 $since = $revisions[$sinceIdx]->getTimestamp();
747 $allRows = iterator_to_array( $dbw->select(
749 [ 'rev_id', 'rev_timestamp', 'rev_user' ],
751 'rev_page' => $page->getId(),
752 //'rev_timestamp > ' . $dbw->addQuotes( $dbw->timestamp( $since ) )
755 [ 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 50 ]
758 $wasLast = Revision
::userWasLastToEdit( $dbw, $page->getId(), $userA->getId(), $since );
760 $this->assertEquals( $expectedLast, $wasLast );
764 * @param string $text
765 * @param string $title
766 * @param string $model
767 * @param string $format
771 private function newTestRevision( $text, $title = "Test",
772 $model = CONTENT_MODEL_WIKITEXT
, $format = null
774 if ( is_string( $title ) ) {
775 $title = Title
::newFromText( $title );
778 $content = ContentHandler
::makeContent( $text, $title, $model, $format );
786 'content' => $content,
787 'length' => $content->getSize(),
788 'comment' => "testing",
789 'minor_edit' => false,
791 'content_format' => $format,
798 public function provideGetContentModel() {
799 // NOTE: we expect the help namespace to always contain wikitext
801 [ 'hello world', 'Help:Hello', null, null, CONTENT_MODEL_WIKITEXT
],
802 [ 'hello world', 'User:hello/there.css', null, null, CONTENT_MODEL_CSS
],
803 [ serialize( 'hello world' ), 'Dummy:Hello', null, null, DummyContentForTesting
::MODEL_ID
],
808 * @dataProvider provideGetContentModel
809 * @covers Revision::getContentModel
811 public function testGetContentModel( $text, $title, $model, $format, $expectedModel ) {
812 $rev = $this->newTestRevision( $text, $title, $model, $format );
814 $this->assertEquals( $expectedModel, $rev->getContentModel() );
817 public function provideGetContentFormat() {
818 // NOTE: we expect the help namespace to always contain wikitext
820 [ 'hello world', 'Help:Hello', null, null, CONTENT_FORMAT_WIKITEXT
],
821 [ 'hello world', 'Help:Hello', CONTENT_MODEL_CSS
, null, CONTENT_FORMAT_CSS
],
822 [ 'hello world', 'User:hello/there.css', null, null, CONTENT_FORMAT_CSS
],
823 [ serialize( 'hello world' ), 'Dummy:Hello', null, null, DummyContentForTesting
::MODEL_ID
],
828 * @dataProvider provideGetContentFormat
829 * @covers Revision::getContentFormat
831 public function testGetContentFormat( $text, $title, $model, $format, $expectedFormat ) {
832 $rev = $this->newTestRevision( $text, $title, $model, $format );
834 $this->assertEquals( $expectedFormat, $rev->getContentFormat() );
837 public function provideGetContentHandler() {
838 // NOTE: we expect the help namespace to always contain wikitext
840 [ 'hello world', 'Help:Hello', null, null, 'WikitextContentHandler' ],
841 [ 'hello world', 'User:hello/there.css', null, null, 'CssContentHandler' ],
842 [ serialize( 'hello world' ), 'Dummy:Hello', null, null, 'DummyContentHandlerForTesting' ],
847 * @dataProvider provideGetContentHandler
848 * @covers Revision::getContentHandler
850 public function testGetContentHandler( $text, $title, $model, $format, $expectedClass ) {
851 $rev = $this->newTestRevision( $text, $title, $model, $format );
853 $this->assertEquals( $expectedClass, get_class( $rev->getContentHandler() ) );
856 public function provideGetContent() {
857 // NOTE: we expect the help namespace to always contain wikitext
859 [ 'hello world', 'Help:Hello', null, null, Revision
::FOR_PUBLIC
, 'hello world' ],
861 serialize( 'hello world' ),
863 DummyContentForTesting
::MODEL_ID
,
865 Revision
::FOR_PUBLIC
,
866 serialize( 'hello world' )
869 serialize( 'hello world' ),
873 Revision
::FOR_PUBLIC
,
874 serialize( 'hello world' )
880 * @dataProvider provideGetContent
881 * @covers Revision::getContent
883 public function testGetContent( $text, $title, $model, $format,
884 $audience, $expectedSerialization
886 $rev = $this->newTestRevision( $text, $title, $model, $format );
887 $content = $rev->getContent( $audience );
890 $expectedSerialization,
891 is_null( $content ) ?
null : $content->serialize( $format )
896 * @covers Revision::getContent
898 public function testGetContent_failure() {
899 $rev = new Revision( [
900 'page' => $this->testPage
->getId(),
901 'content_model' => $this->testPage
->getContentModel(),
902 'text_id' => 123456789, // not in the test DB
905 MediaWiki\
suppressWarnings(); // bad text_id will trigger a warning.
907 $this->assertNull( $rev->getContent(),
908 "getContent() should return null if the revision's text blob could not be loaded." );
910 // NOTE: check this twice, once for lazy initialization, and once with the cached value.
911 $this->assertNull( $rev->getContent(),
912 "getContent() should return null if the revision's text blob could not be loaded." );
914 MediaWiki\
suppressWarnings( 'end' );
917 public function provideGetSize() {
919 [ "hello world.", CONTENT_MODEL_WIKITEXT
, 12 ],
920 [ serialize( "hello world." ), DummyContentForTesting
::MODEL_ID
, 12 ],
925 * @covers Revision::getSize
926 * @dataProvider provideGetSize
928 public function testGetSize( $text, $model, $expected_size ) {
929 $rev = $this->newTestRevision( $text, 'RevisionTest_testGetSize', $model );
930 $this->assertEquals( $expected_size, $rev->getSize() );
933 public function provideGetSha1() {
935 [ "hello world.", CONTENT_MODEL_WIKITEXT
, Revision
::base36Sha1( "hello world." ) ],
937 serialize( "hello world." ),
938 DummyContentForTesting
::MODEL_ID
,
939 Revision
::base36Sha1( serialize( "hello world." ) )
945 * @covers Revision::getSha1
946 * @dataProvider provideGetSha1
948 public function testGetSha1( $text, $model, $expected_hash ) {
949 $rev = $this->newTestRevision( $text, 'RevisionTest_testGetSha1', $model );
950 $this->assertEquals( $expected_hash, $rev->getSha1() );
954 * Tests whether $rev->getContent() returns a clone when needed.
956 * @covers Revision::getContent
958 public function testGetContentClone() {
959 $content = new RevisionTestModifyableContent( "foo" );
965 'title' => Title
::newFromText( "testGetContentClone_dummy" ),
967 'content' => $content,
968 'length' => $content->getSize(),
969 'comment' => "testing",
970 'minor_edit' => false,
974 /** @var RevisionTestModifyableContent $content */
975 $content = $rev->getContent( Revision
::RAW
);
976 $content->setText( "bar" );
978 /** @var RevisionTestModifyableContent $content2 */
979 $content2 = $rev->getContent( Revision
::RAW
);
980 // content is mutable, expect clone
981 $this->assertNotSame( $content, $content2, "expected a clone" );
982 // clone should contain the original text
983 $this->assertEquals( "foo", $content2->getText() );
985 $content2->setText( "bla bla" );
986 // clones should be independent
987 $this->assertEquals( "bar", $content->getText() );
991 * Tests whether $rev->getContent() returns the same object repeatedly if appropriate.
992 * @covers Revision::getContent
994 public function testGetContentUncloned() {
995 $rev = $this->newTestRevision( "hello", "testGetContentUncloned_dummy", CONTENT_MODEL_WIKITEXT
);
996 $content = $rev->getContent( Revision
::RAW
);
997 $content2 = $rev->getContent( Revision
::RAW
);
999 // for immutable content like wikitext, this should be the same object
1000 $this->assertSame( $content, $content2 );
1004 * @covers Revision::loadFromId
1006 public function testLoadFromId() {
1007 $rev = $this->testPage
->getRevision();
1008 $this->hideDeprecated( 'Revision::loadFromId' );
1009 $this->assertRevEquals(
1011 Revision
::loadFromId( wfGetDB( DB_MASTER
), $rev->getId() )
1016 * @covers Revision::loadFromPageId
1018 public function testLoadFromPageId() {
1019 $this->assertRevEquals(
1020 $this->testPage
->getRevision(),
1021 Revision
::loadFromPageId( wfGetDB( DB_MASTER
), $this->testPage
->getId() )
1026 * @covers Revision::loadFromPageId
1028 public function testLoadFromPageIdWithLatestRevId() {
1029 $this->assertRevEquals(
1030 $this->testPage
->getRevision(),
1031 Revision
::loadFromPageId(
1032 wfGetDB( DB_MASTER
),
1033 $this->testPage
->getId(),
1034 $this->testPage
->getLatest()
1040 * @covers Revision::loadFromPageId
1042 public function testLoadFromPageIdWithNotLatestRevId() {
1043 $this->testPage
->doEditContent( new WikitextContent( __METHOD__
), __METHOD__
);
1044 $this->assertRevEquals(
1045 $this->testPage
->getRevision()->getPrevious(),
1046 Revision
::loadFromPageId(
1047 wfGetDB( DB_MASTER
),
1048 $this->testPage
->getId(),
1049 $this->testPage
->getRevision()->getPrevious()->getId()
1055 * @covers Revision::loadFromTitle
1057 public function testLoadFromTitle() {
1058 $this->assertRevEquals(
1059 $this->testPage
->getRevision(),
1060 Revision
::loadFromTitle( wfGetDB( DB_MASTER
), $this->testPage
->getTitle() )
1065 * @covers Revision::loadFromTitle
1067 public function testLoadFromTitleWithLatestRevId() {
1068 $this->assertRevEquals(
1069 $this->testPage
->getRevision(),
1070 Revision
::loadFromTitle(
1071 wfGetDB( DB_MASTER
),
1072 $this->testPage
->getTitle(),
1073 $this->testPage
->getLatest()
1079 * @covers Revision::loadFromTitle
1081 public function testLoadFromTitleWithNotLatestRevId() {
1082 $this->testPage
->doEditContent( new WikitextContent( __METHOD__
), __METHOD__
);
1083 $this->assertRevEquals(
1084 $this->testPage
->getRevision()->getPrevious(),
1085 Revision
::loadFromTitle(
1086 wfGetDB( DB_MASTER
),
1087 $this->testPage
->getTitle(),
1088 $this->testPage
->getRevision()->getPrevious()->getId()
1094 * @covers Revision::loadFromTimestamp()
1096 public function testLoadFromTimestamp() {
1097 $this->assertRevEquals(
1098 $this->testPage
->getRevision(),
1099 Revision
::loadFromTimestamp(
1100 wfGetDB( DB_MASTER
),
1101 $this->testPage
->getTitle(),
1102 $this->testPage
->getRevision()->getTimestamp()
1108 * @covers Revision::getParentLengths
1110 public function testGetParentLengths_noRevIds() {
1113 Revision
::getParentLengths(
1114 wfGetDB( DB_MASTER
),
1121 * @covers Revision::getParentLengths
1123 public function testGetParentLengths_oneRevId() {
1124 $text = '831jr091jr0921kr21kr0921kjr0921j09rj1';
1125 $textLength = strlen( $text );
1127 $this->testPage
->doEditContent( new WikitextContent( $text ), __METHOD__
);
1128 $rev[1] = $this->testPage
->getLatest();
1131 [ $rev[1] => $textLength ],
1132 Revision
::getParentLengths(
1133 wfGetDB( DB_MASTER
),
1140 * @covers Revision::getParentLengths
1142 public function testGetParentLengths_multipleRevIds() {
1143 $textOne = '831jr091jr0921kr21kr0921kjr0921j09rj1';
1144 $textOneLength = strlen( $textOne );
1145 $textTwo = '831jr091jr092121j09rj1';
1146 $textTwoLength = strlen( $textTwo );
1148 $this->testPage
->doEditContent( new WikitextContent( $textOne ), __METHOD__
);
1149 $rev[1] = $this->testPage
->getLatest();
1150 $this->testPage
->doEditContent( new WikitextContent( $textTwo ), __METHOD__
);
1151 $rev[2] = $this->testPage
->getLatest();
1154 [ $rev[1] => $textOneLength, $rev[2] => $textTwoLength ],
1155 Revision
::getParentLengths(
1156 wfGetDB( DB_MASTER
),
1157 [ $rev[1], $rev[2] ]
1163 * @covers Revision::getTitle
1165 public function testGetTitle_fromExistingRevision() {
1167 $this->testPage
->getTitle()->equals(
1168 $this->testPage
->getRevision()->getTitle()
1174 * @covers Revision::getTitle
1176 public function testGetTitle_fromRevisionWhichWillLoadTheTitle() {
1177 $rev = new Revision( [ 'id' => $this->testPage
->getLatest() ] );
1179 $this->testPage
->getTitle()->equals(
1186 * @covers Revision::isMinor
1188 public function testIsMinor_true() {
1189 // Use a sysop to ensure we can mark edits as minor
1190 $sysop = $this->getTestSysop()->getUser();
1192 $this->testPage
->doEditContent(
1193 new WikitextContent( __METHOD__
),
1199 $rev = $this->testPage
->getRevision();
1201 $this->assertSame( true, $rev->isMinor() );
1205 * @covers Revision::isMinor
1207 public function testIsMinor_false() {
1208 $this->testPage
->doEditContent(
1209 new WikitextContent( __METHOD__
),
1213 $rev = $this->testPage
->getRevision();
1215 $this->assertSame( false, $rev->isMinor() );
1219 * @covers Revision::getTimestamp
1221 public function testGetTimestamp() {
1222 $testTimestamp = wfTimestampNow();
1224 $this->testPage
->doEditContent(
1225 new WikitextContent( __METHOD__
),
1228 $rev = $this->testPage
->getRevision();
1230 $this->assertInternalType( 'string', $rev->getTimestamp() );
1231 $this->assertTrue( strlen( $rev->getTimestamp() ) == strlen( 'YYYYMMDDHHMMSS' ) );
1232 $this->assertContains( substr( $testTimestamp, 0, 10 ), $rev->getTimestamp() );
1236 * @covers Revision::getUser
1237 * @covers Revision::getUserText
1239 public function testGetUserAndText() {
1240 $sysop = $this->getTestSysop()->getUser();
1242 $this->testPage
->doEditContent(
1243 new WikitextContent( __METHOD__
),
1249 $rev = $this->testPage
->getRevision();
1251 $this->assertSame( $sysop->getId(), $rev->getUser() );
1252 $this->assertSame( $sysop->getName(), $rev->getUserText() );
1256 * @covers Revision::isDeleted
1258 public function testIsDeleted_nothingDeleted() {
1259 $rev = $this->testPage
->getRevision();
1261 $this->assertSame( false, $rev->isDeleted( Revision
::DELETED_TEXT
) );
1262 $this->assertSame( false, $rev->isDeleted( Revision
::DELETED_COMMENT
) );
1263 $this->assertSame( false, $rev->isDeleted( Revision
::DELETED_RESTRICTED
) );
1264 $this->assertSame( false, $rev->isDeleted( Revision
::DELETED_USER
) );
1268 * @covers Revision::getVisibility
1270 public function testGetVisibility_nothingDeleted() {
1271 $rev = $this->testPage
->getRevision();
1273 $this->assertSame( 0, $rev->getVisibility() );
1277 * @covers Revision::getComment
1279 public function testGetComment_notDeleted() {
1280 $expectedSummary = 'goatlicious summary';
1282 $this->testPage
->doEditContent(
1283 new WikitextContent( __METHOD__
),
1286 $rev = $this->testPage
->getRevision();
1288 $this->assertSame( $expectedSummary, $rev->getComment() );
1292 * @covers Revision::isUnpatrolled
1294 public function testIsUnpatrolled_returnsRecentChangesId() {
1295 $this->testPage
->doEditContent( new WikitextContent( __METHOD__
), __METHOD__
);
1296 $rev = $this->testPage
->getRevision();
1298 $this->assertGreaterThan( 0, $rev->isUnpatrolled() );
1299 $this->assertSame( $rev->getRecentChange()->getAttribute( 'rc_id' ), $rev->isUnpatrolled() );
1303 * @covers Revision::isUnpatrolled
1305 public function testIsUnpatrolled_returnsZeroIfPatrolled() {
1306 // This assumes that sysops are auto patrolled
1307 $sysop = $this->getTestSysop()->getUser();
1308 $this->testPage
->doEditContent(
1309 new WikitextContent( __METHOD__
),
1315 $rev = $this->testPage
->getRevision();
1317 $this->assertSame( 0, $rev->isUnpatrolled() );
1321 * This is a simple blanket test for all simple content getters and is methods to provide some
1322 * coverage before the split of Revision into multiple classes for MCR work.
1323 * @covers Revision::getContent
1324 * @covers Revision::getSerializedData
1325 * @covers Revision::getContentModel
1326 * @covers Revision::getContentFormat
1327 * @covers Revision::getContentHandler
1329 public function testSimpleContentGetters() {
1330 $expectedText = 'testSimpleContentGetters in Revision. Goats love MCR...';
1331 $expectedSummary = 'goatlicious testSimpleContentGetters summary';
1333 $this->testPage
->doEditContent(
1334 new WikitextContent( $expectedText ),
1337 $rev = $this->testPage
->getRevision();
1339 $this->assertSame( $expectedText, $rev->getContent()->getNativeData() );
1340 $this->assertSame( $expectedText, $rev->getSerializedData() );
1341 $this->assertSame( $this->testPage
->getContentModel(), $rev->getContentModel() );
1342 $this->assertSame( $this->testPage
->getContent()->getDefaultFormat(), $rev->getContentFormat() );
1343 $this->assertSame( $this->testPage
->getContentHandler(), $rev->getContentHandler() );
1347 * @covers Revision::newKnownCurrent
1349 public function testNewKnownCurrent() {
1350 // Setup the services
1351 $cache = new WANObjectCache( [ 'cache' => new HashBagOStuff() ] );
1352 $this->setService( 'MainWANObjectCache', $cache );
1353 $db = wfGetDB( DB_MASTER
);
1355 // Get a fresh revision to use during testing
1356 $this->testPage
->doEditContent( new WikitextContent( __METHOD__
), __METHOD__
);
1357 $rev = $this->testPage
->getRevision();
1359 // Clear any previous cache for the revision during creation
1360 $key = $cache->makeGlobalKey( 'revision-row-1.29',
1365 $cache->delete( $key, WANObjectCache
::HOLDOFF_NONE
);
1366 $this->assertFalse( $cache->get( $key ) );
1368 // Get the new revision and make sure it is in the cache and correct
1369 $newRev = Revision
::newKnownCurrent( $db, $rev->getPage(), $rev->getId() );
1370 $this->assertRevEquals( $rev, $newRev );
1372 $cachedRow = $cache->get( $key );
1373 $this->assertNotFalse( $cachedRow );
1374 $this->assertEquals( $rev->getId(), $cachedRow->rev_id
);
1377 public function testNewKnownCurrent_withPageId() {
1378 $db = wfGetDB( DB_MASTER
);
1380 $this->testPage
->doEditContent( new WikitextContent( __METHOD__
), __METHOD__
);
1381 $rev = $this->testPage
->getRevision();
1383 $pageId = $this->testPage
->getId();
1385 $newRev = Revision
::newKnownCurrent( $db, $pageId, $rev->getId() );
1386 $this->assertRevEquals( $rev, $newRev );
1389 public function testNewKnownCurrent_returnsFalseWhenTitleDoesntExist() {
1390 $db = wfGetDB( DB_MASTER
);
1392 $this->assertFalse( Revision
::newKnownCurrent( $db, 0 ) );
1395 public function provideUserCanBitfield() {
1396 yield
[ 0, 0, [], null, true ];
1397 // Bitfields match, user has no permissions
1398 yield
[ Revision
::DELETED_TEXT
, Revision
::DELETED_TEXT
, [], null, false ];
1399 yield
[ Revision
::DELETED_COMMENT
, Revision
::DELETED_COMMENT
, [], null, false ];
1400 yield
[ Revision
::DELETED_USER
, Revision
::DELETED_USER
, [], null, false ];
1401 yield
[ Revision
::DELETED_RESTRICTED
, Revision
::DELETED_RESTRICTED
, [], null, false ];
1402 // Bitfields match, user (admin) does have permissions
1403 yield
[ Revision
::DELETED_TEXT
, Revision
::DELETED_TEXT
, [ 'sysop' ], null, true ];
1404 yield
[ Revision
::DELETED_COMMENT
, Revision
::DELETED_COMMENT
, [ 'sysop' ], null, true ];
1405 yield
[ Revision
::DELETED_USER
, Revision
::DELETED_USER
, [ 'sysop' ], null, true ];
1406 // Bitfields match, user (admin) does not have permissions
1407 yield
[ Revision
::DELETED_RESTRICTED
, Revision
::DELETED_RESTRICTED
, [ 'sysop' ], null, false ];
1408 // Bitfields match, user (oversight) does have permissions
1409 yield
[ Revision
::DELETED_RESTRICTED
, Revision
::DELETED_RESTRICTED
, [ 'oversight' ], null, true ];
1410 // Check permissions using the title
1412 Revision
::DELETED_TEXT
,
1413 Revision
::DELETED_TEXT
,
1415 Title
::newFromText( __METHOD__
),
1419 Revision
::DELETED_TEXT
,
1420 Revision
::DELETED_TEXT
,
1422 Title
::newFromText( __METHOD__
),
1428 * @dataProvider provideUserCanBitfield
1429 * @covers Revision::userCanBitfield
1431 public function testUserCanBitfield( $bitField, $field, $userGroups, $title, $expected ) {
1432 $this->setMwGlobals(
1433 'wgGroupPermissions',
1436 'deletedtext' => true,
1437 'deletedhistory' => true,
1440 'viewsuppressed' => true,
1441 'suppressrevision' => true,
1445 $user = $this->getTestUser( $userGroups )->getUser();
1449 Revision
::userCanBitfield( $bitField, $field, $user, $title )
1452 // Fallback to $wgUser
1453 $this->setMwGlobals(
1459 Revision
::userCanBitfield( $bitField, $field, null, $title )
1463 public function provideUserCan() {
1464 yield
[ 0, 0, [], true ];
1465 // Bitfields match, user has no permissions
1466 yield
[ Revision
::DELETED_TEXT
, Revision
::DELETED_TEXT
, [], false ];
1467 yield
[ Revision
::DELETED_COMMENT
, Revision
::DELETED_COMMENT
, [], false ];
1468 yield
[ Revision
::DELETED_USER
, Revision
::DELETED_USER
, [], false ];
1469 yield
[ Revision
::DELETED_RESTRICTED
, Revision
::DELETED_RESTRICTED
, [], false ];
1470 // Bitfields match, user (admin) does have permissions
1471 yield
[ Revision
::DELETED_TEXT
, Revision
::DELETED_TEXT
, [ 'sysop' ], true ];
1472 yield
[ Revision
::DELETED_COMMENT
, Revision
::DELETED_COMMENT
, [ 'sysop' ], true ];
1473 yield
[ Revision
::DELETED_USER
, Revision
::DELETED_USER
, [ 'sysop' ], true ];
1474 // Bitfields match, user (admin) does not have permissions
1475 yield
[ Revision
::DELETED_RESTRICTED
, Revision
::DELETED_RESTRICTED
, [ 'sysop' ], false ];
1476 // Bitfields match, user (oversight) does have permissions
1477 yield
[ Revision
::DELETED_RESTRICTED
, Revision
::DELETED_RESTRICTED
, [ 'oversight' ], true ];
1481 * @dataProvider provideUserCan
1482 * @covers Revision::userCan
1484 public function testUserCan( $bitField, $field, $userGroups, $expected ) {
1485 $this->setMwGlobals(
1486 'wgGroupPermissions',
1489 'deletedtext' => true,
1490 'deletedhistory' => true,
1493 'viewsuppressed' => true,
1494 'suppressrevision' => true,
1498 $user = $this->getTestUser( $userGroups )->getUser();
1499 $revision = new Revision( [ 'deleted' => $bitField ], 0, $this->testPage
->getTitle() );
1503 $revision->userCan( $field, $user )